Skip to content

Docs for next release + Update Plotlyjs version #4104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Mar 28, 2023
Merged

Docs for next release + Update Plotlyjs version #4104

merged 23 commits into from
Mar 28, 2023

Conversation

LiamConnors
Copy link
Member

@LiamConnors LiamConnors commented Mar 14, 2023

This PR:

  • Updates the Plotly.js version to 2.20.0
  • Adds docs for:
    • Labels on shapes
    • Automargin on plot titles
    • Label aliases

Documentation PR

  • I've seen the doc/README.md file
  • This change runs in the current version of Plotly on PyPI and targets the doc-prod branch OR it targets the master branch
  • If this PR modifies the first example in a page or adds a new one, it is a px example if at all possible
  • Every new/modified example has a descriptive title and motivating sentence or paragraph
  • Every new/modified example is independently runnable
  • Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized
  • Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
  • The random seed is set if using randomly-generated data in new/modified examples
  • New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
  • Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
  • Imports are plotly.graph_objects as go / plotly.express as px / plotly.io as pio
  • Data frames are always called df
  • fig = <something> call is high up in each new/modified example (either px.<something> or make_subplots or go.Figure)
  • Liberal use is made of fig.add_* and fig.update_* rather than go.Figure(data=..., layout=...) in every new/modified example
  • Specific adders and updaters like fig.add_shape and fig.update_xaxes are used instead of big fig.update_layout calls in every new/modified example
  • fig.show() is at the end of each new/modified example
  • plotly.plot() and plotly.iplot() are not used in any new/modified example
  • Hex codes for colors are not used in any new/modified example in favour of these nice ones

Code PR

  • I have read through the contributing notes and understand the structure of the package. In particular, if my PR modifies code of plotly.graph_objects, my modifications concern the codegen files and not generated files.
  • I have added tests (if submitting a new feature or correcting a bug) or
    modified existing tests.
  • For a new feature, I have added documentation examples in an existing or
    new tutorial notebook (please see the doc checklist as well).
  • I have added a CHANGELOG entry if fixing/changing/adding anything substantial.
  • For a new feature or a change in behaviour, I have updated the relevant docstrings in the code to describe the feature or behaviour (please see the doc checklist as well).

-->

@LiamConnors LiamConnors changed the title March docs Docs for next release Mar 14, 2023
@LiamConnors LiamConnors changed the title Docs for next release Docs for next release + Update Plotlyjs version Mar 15, 2023
@nicolaskruchten
Copy link
Contributor

Yay, the tests pass now that we have the JS bump in here :)

Feel free to keep stacking on to this, including with the 2.20 JS bump once it comes and we can merge this whole thing in at once.

@LiamConnors LiamConnors requested a review from archmoj March 15, 2023 20:03
@LiamConnors
Copy link
Member Author

Still need to add something for automargin in 2.20.0, but if you could start taking a look at what's here already, that would be great @archmoj. Thanks!

@LiamConnors LiamConnors marked this pull request as ready for review March 16, 2023 15:02
@LiamConnors
Copy link
Member Author

@archmoj this one is ready for review. With examples based on 2.19.0 and 2.20.0 Plotly.js release

@LiamConnors LiamConnors requested a review from archmoj March 16, 2023 17:10
@archmoj
Copy link
Contributor

archmoj commented Mar 16, 2023

All looking good to me.
Thanks @LiamConnors 🎖️

@LiamConnors
Copy link
Member Author

Last commit to fix issue with building the aggregations page when using that original link. Replaced it with a link to the same dataset in the datasets repo

@LiamConnors LiamConnors requested a review from chriddyp March 21, 2023 18:47
@@ -144,7 +144,7 @@ import plotly.io as pio

import pandas as pd

df = pd.read_csv("https://plotly.com/~public.health/17.csv")
df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/US-shooting-incidents.csv")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you please explain why this dataset is changed?
On another - IMHO it would be better to depend on a permanent link as these kind of files may change location and content in future.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pandas is sometimes unable to load the dataset from "https://plotly.com/~public.health/17.csv".
It sometimes throws an error and the tests were failing because of it.

We have a repo specifically for datasets that is where the updated link is. But it's the same dataset.

So it is now at https://plotly.github.io/datasets. We actually have a check in the PR that new datasets should be loaded from there.

"New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets"

And this is where we load most external datasets from. For example, the pages on https://plotly.com/python/tick-formatting/

@LiamConnors LiamConnors requested a review from archmoj March 27, 2023 16:35
@archmoj
Copy link
Contributor

archmoj commented Mar 27, 2023

@LiamConnors would you mind checking the boxes in the PR description?
Thank you! 🥇
Other than that it looks ready to go 🚀

@archmoj
Copy link
Contributor

archmoj commented Mar 27, 2023

💃

Copy link
Member

@chriddyp chriddyp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃🏼

@archmoj archmoj merged commit f4609fc into master Mar 28, 2023
@archmoj archmoj deleted the march-docs branch March 28, 2023 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants